# -------------------------------------------------------------
#
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
#
# -------------------------------------------------------------

# Autogenerated By   : src/main/python/generator/generator.py
# Autogenerated From : scripts/builtin/matrixProfile.dml

from typing import Dict, Iterable

from systemds.operator import OperationNode, Matrix, Frame, List, MultiReturn, Scalar
from systemds.script_building.dag import OutputType
from systemds.utils.consts import VALID_INPUT_TYPES


def matrixProfile(ts: Matrix,
                  **kwargs: Dict[str, VALID_INPUT_TYPES]):
    """
     Builtin function that computes the MatrixProfile of a time series efficiently
     using the SCRIMP++ algorithm.
    
     .. code-block::
    
       References:
       Yan Zhu et al.. 2018.
         Matrix Profile XI: SCRIMP++: Time Series Motif Discovery at Interactive Speeds.
         2018 IEEE International Conference on Data Mining (ICDM), 2018, pp. 837-846.
         DOI: 10.1109/ICDM.2018.00099.
         https://www.cs.ucr.edu/~eamonn/SCRIMP_ICDM_camera_ready_updated.pdf
    
    
    
    :param ts: Time series to profile
    :param window_size: Sliding window size
    :param sample_percent: Degree of approximation
        between zero and one (1
        computes the exact solution)
    :param is_verbose: Print debug information
    :return: The computed matrix profile
    :return: Indices of least distances
    """

    params_dict = {'ts': ts}
    params_dict.update(kwargs)
    
    vX_0 = Matrix(ts.sds_context, '')
    vX_1 = Matrix(ts.sds_context, '')
    output_nodes = [vX_0, vX_1, ]

    op = MultiReturn(ts.sds_context, 'matrixProfile', output_nodes, named_input_nodes=params_dict)

    vX_0._unnamed_input_nodes = [op]
    vX_1._unnamed_input_nodes = [op]

    return op
